home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d13 / peptool1.arc / PEPTOOLS.DOC < prev    next >
Encoding:
Text File  |  1991-03-26  |  18.4 KB  |  378 lines

  1.                      *  Telix PEP Tools  v1.5  *
  2.                     TELIX v3.12 Script File Tools
  3.                       Written by Michael Gillum
  4.                       Last Updated: 03-12-91
  5.  
  6. The Telix PEPTOOLS v1.5 are provided as Shareware. Meaning you have
  7. the right to try them out for a limited period of 30 days. After which
  8. you should either register them with the author, or discontinue usage.
  9. Registering the tools will provide you with:
  10.  
  11.  a) An unlimited version of PEPTOOLS.
  12.  
  13.     A few of the TOOLS such as SEDITOR, and ROBOLOG, and PInstall are
  14.     limited versions. The limitations do not take away from the actual
  15.     work-a-bility of these tools, but the registered versions support
  16.     many more features. For example:
  17.  
  18.           SEDITOR, as is, does not support word-wrap or insert mode.
  19.           These are additional features that will enhance its
  20.           functionality, but do not limit its present usage.
  21.  
  22.           ROBOLOG, is for the most part complete. However, some
  23.           modifications will be necessary to the scripts that are
  24.           created with the "Learn" facilities. The registered version
  25.           clears this up. With registration, the "Learn" facility is
  26.           expanded and writes totally completed, totally functional
  27.           scripts. This is not to say that the scripts created with
  28.           the Un-registered version are not workable, only that there
  29.           is some modification required for decision making process
  30.           that have been kept out of the unregistered version.
  31.  
  32.           PINSTALL, as is, assigns the tools to predetermined keys (as
  33.           shown on the screen). The registered version of PInstall
  34.           allows for custom selecting of keys to use in the
  35.           installation.
  36.  
  37.           Also. A few of the tools will check for color display (based
  38.           on what is installed in Telix) and use these, but most are
  39.           configured for Black & White display only. In the registered
  40.           version, full-color support is activated for ALL tools that
  41.           use the display screen.
  42.  
  43.  b) Notification, and access to any "fixes" free of charge.
  44.  
  45.  c) Upgrades at a very low cost.
  46.  
  47.  d) Registration will also provide you with unlimited technical
  48.     support.
  49.  
  50.  e) A complete listing (reference manual) of instructions and syntax
  51.     for using the "called" scripts, or "Utilities" in PEPTOOLS, (plus
  52.     an extended version of the utilities) for scripts you may decide
  53.     to write yourself. As is, the called scripts included are used by
  54.     many of the TOOLS, most of these (and others) can be used just as
  55.     easily by you.
  56.  
  57.  f) Access to the complete source code for all scripts, at a small,
  58.     additional charge of $5.00. No source code is available without
  59.     registration.
  60.  
  61. Even as is, the PEPTOOLS are quite a bargain, but as you can see,
  62. registration greatly expands many of the ideas present in the
  63. PEPTOOLS. I highly recommend registration of the tools (of course!)
  64.  
  65. Registration of PEPTOOLS costs a mere $15.00 payable in check, or
  66. Money Order, payable to:
  67.  
  68.                             Michael Gillum
  69.                        20806 S. Western Ave. #1
  70.                           Torrance Ca. 90501
  71.                             (213) 787-9461
  72.  
  73. An order form is provided in a separate document, for your convenience.
  74.  
  75.                               Contents:
  76.  
  77.  Documentation:  PEPTOOLS.DOC   SEDITOR.DOC   ROBOLOG.DOC   ORDER.DOC
  78.  
  79.                            Compiled Scripts
  80.                            ----------------
  81.                              ROBOLOG .SLC
  82.                              SEDITOR .SLC
  83.                              PINSTALL.SLC
  84.                              VIEWFILE.SLC
  85.                              LISTDIR .SLC
  86.                              SEARCHER.SLC
  87.                              TDIR    .SLC
  88.                              DIALDIR .SLC
  89.                              FILE_ERR.SLC
  90.                              READCFG .SLC
  91.                              GETATTR .SLC
  92.                              LASTPOS .SLC
  93.                              ASCIIUP .SLC
  94.                              DATETIME.SLC
  95.                              KEYS    .SLC
  96.                              LOADKEYS.SLC
  97.                              LOGOFF  .SLC
  98.                              MEMEXTRC.SLC
  99.                              BAUDDRAG.SLC
  100.                              ANSISCRN.SLC
  101.  
  102. Here are a set of automated scripts that were basically designed to be
  103. timesavers.
  104.  
  105. Installing PEPTOOLS
  106. -------------------
  107. For a custom installation of all the PEPTOOLS, execute first, a script
  108. called "PInstall." This script does a couple things.
  109.  
  110. First, it creates a color config file for a few of the scripts by
  111. reading both, the attributes from the screen, and then comparing those
  112. with Telix's actual configuration, in "Telix.cnf."
  113.  
  114. Second, it installs all the tools to a Telix "key" file of which you
  115. provide the name. This allows all the tools to be called by pressing a
  116. function key (or Alt-function key), making usage much easier. Telix
  117. defaults to a key file called "Telix.key" when first loaded. You can
  118. either select this as your key file, or give it any name you wish.
  119.  
  120. As a rule, if you do not choose Telix.key as your "tools key file" I
  121. would at least, add to Telix.key, two tools. First, "Keys" as this
  122. shows what is stored in the active key file, and second, "Loadkeys"
  123. since this makes loading other key files a lot easier than Telix does.
  124.  
  125.  
  126. Summary of Scripts:
  127. -------------------
  128.   PInstall :  As mentioned above, this is the installation script for
  129.               all the tools. This script should be executed first,
  130.               even if you are not going to assign the tools to
  131.               function keys because PInstall also creates a color
  132.               config file for a couple of the tools.
  133.  
  134.   ROBOLog  :  Automated-Timed script executor, with built in Script
  135.               Writer.
  136.  
  137.                 *Documentation contained in a separate file.
  138.  
  139.   Seditor  :  An online editor that offers more flexibility than many
  140.               of the "Line Type" editors encountered on many services.
  141.               Seditor is small, 18 lines max, with 60 character right
  142.               margin. Designed as an "on-the-fly" basic message editor
  143.               to alleviate the need for loading a bulky, external
  144.               editor from TELIX simply to compose a short message.
  145.  
  146.                 *Documentation contained in a separate file.
  147.  
  148.   ViewFile :  Allows viewing any file. Saves you from having to load
  149.               your editor just to view the contents of a file. Will
  150.               handle files up to 175,00 bytes in size (approx 200
  151.               pages). Also accepts (*) wildcard character, to specify
  152.               a particular set of files.
  153.  
  154.   ListDir  :  Displays a "wide screen" disk directory for selected
  155.               directories. You provide the search path. Dos wildcard
  156.               character (*) is acceptable.
  157.  
  158.   Searcher :  Searcher v1.0 is a modem number seeker. You choose a set
  159.               of prefixes and a low to high number, then Searcher will
  160.               dial those prefixes and numbers searching for a modem.
  161.               If a modem is found, the number is logged in a file
  162.               named MODEMS.SRC. A log of prefixes with low and high
  163.               numbers is kept for future reference in a file named
  164.               SEARCHER.LOG.
  165.  
  166.               Searcher acknowledges a "carrier signal" as a modem
  167.               number. Any numbers called that are busy, voice
  168.               answered, or not answered at all are ignored. No log is
  169.               kept of Non-Modem numbers. It is possible that Searcher
  170.               will overlook some actual modem numbers due to either no
  171.               answer, or a busy signal. Only one attempt per number is
  172.               executed when dialing.
  173.  
  174.   Datetime :  Displays the date and time on the screen for approx, 5
  175.               seconds.
  176.  
  177.   AsciiUp  :  Prompts you for a filename, then does an ASCII upload.
  178.               Saves you from having to select a protocol simply to
  179.               upload a message, etc. This will only work for ASCII
  180.               (Text) uploads.
  181.  
  182.   Keys     :  Shows special key assignments for the Function, Alt-
  183.               Function, Shift-Function, and Ctrl-Function keys of the
  184.               presently loaded key file. Put this one in ALL your key
  185.               files to show what's stored in your function keys.
  186.  
  187.   LoadKeys :  Loads selected Key Definition file. This script offers a
  188.               more direct way of loading Key-Def files than TELIX
  189.               v3.12. Simply type in the name, and it's loaded
  190.               (provided it exists - of course!) LOADKEYS assumes all
  191.               key definition files to have the extension of ".KEY"
  192.  
  193.               * Keep in mind, that if you load another Key file,
  194.               unless you have defined a few of the "Tools" to those
  195.               keys too, you will lose the present Key assignment until
  196.               reloaded. (I recommend you at least assign F1 in all
  197.               your Key files to KEYS.SLC to display available keys and
  198.               existing assignments - also, I would assign to some key
  199.               THIS script, LOADKEYS.SLC, so you will retain the
  200.               ability to reload the "Tools")
  201.  
  202.   AnsiScrn :  Qwik display of many of the Ansi Control codes, and
  203.               gives a few brief examples.
  204.  
  205.   DialDir  :  Displays Dialing Directory without pausing at the "Stat
  206.               Bar" like Alt-D does. Instead, this script takes you
  207.               directly to the Directory.
  208.  
  209.   LogOff   :  Gracefully logs you off from anywhere online (even the
  210.               PUBLIC FORUMS, or CHAT situations). There are always
  211.               many ways to "hang-up" the modem connection, but to use
  212.               anything other than the method supported by your BBS
  213.               (Alt-H, Power Off, etc;) is an injustice to the Sysop
  214.               and his equipment. LOGOFF.SLC first issues a Ctrl-C (to
  215.               exit you from most situations - ie:Forum, Chat, etc;),
  216.               then issues "Bye" to the system.
  217.  
  218.  
  219.       * Called Scripts *
  220.       ------------------
  221.         These scripts do little, or nothing by themselves, but play an
  222.         important role in the support of other scripts.
  223.  
  224.         MemExtrc :  Grabs your user number from the dialing directory
  225.                     entry. For use by scripts that automatically log
  226.                     you onto a BBS, that require a user number, as
  227.                     well as a password.
  228.  
  229.         BaudDrag :  This script determines the Baud you are using, and
  230.                     sets a "Drag Factor" for slower (300-1200) Baud
  231.                     rates. Used by scripts that wait for prompts to
  232.                     occur from a host, so the quick looping involved
  233.                     with checking the terminal for incoming characters
  234.                     is closer matched with the speed of the modem. No
  235.                     "Drag Factor" is set if baud is 2400 or greater.
  236.  
  237.         File_Err :  This script handles the display of an error
  238.                     message for problems associated with opening files
  239.                     used by various scripts.
  240.  
  241.         TDir     :  Handles the display of a files directory for other
  242.                     scripts.
  243.  
  244.         GetAttr  :  Reads attributes from two spots on the screen (the
  245.                     status bar line, to determine reverse color, and
  246.                     one line above that, to determine general text
  247.                     color) returning both.
  248.  
  249.         ReadCfg  :  Looks for a file named "PEPCOLOR.CFG" and loads
  250.                     colors for a few of the scripts. PEPCOLOR.CFG is a
  251.                     standard Ascii text file with 3 numbers in it. The
  252.                     first designates standard text color, the second
  253.                     designates reverse video color, and the third
  254.                     designates bold color. PEPCOLOR.CFG is created by
  255.                     PInstall, when first run.
  256.  
  257.         LastPos  :  Searches for the last occurrence of a character
  258.                     within a string. Most notably used in the tools to
  259.                     find the last position of the '\' character in
  260.                     determining the correct path of a directory search
  261.                     that includes a wildcard (*) character. As in:
  262.                     "C:\Telix\upload\*.*".
  263.  
  264. SCRIPT EXECUTION
  265. ----------------
  266. First, you should copy all the files with the extension ".SLC" to your
  267. TELIX v3.12 directory so TELIX v3.12 can find them.
  268.  
  269.   ** TELIX v3.12 can also load scripts by pressing special keys. **
  270.  
  271. To execute any of these scripts press ALT-G and type the name of the
  272. script you wish to start. Rather than use this method, however, I
  273. recommend instead, that you assign the scripts to Function keys.
  274. Assigning the scripts to Function keys is easy, and gives you access
  275. to the tasks the scripts perform in "one-key stroke."
  276.  
  277.             * Note on assigning scripts to a keystroke *
  278.               ----------------------------------------
  279.      If you choose not to use the PInstall assignments, you can
  280.      individually assign the tools to function keys yourself. By
  281.      pressing ALT-K while in TELIX v3.12, you will be taken to the
  282.      Keyboard assignment section. From here press 'E' for edit, then
  283.      press the key you wish to assign to the execution of a particular
  284.      script. When assigning a keystroke to an executable script file
  285.      you have to begin the line with the '@' character. Simply type
  286.      @[name of script] (no brackets) and the selected key will be
  287.      assigned to execute that particular script. Next, press 'S' to
  288.      save the assignments you have just made. (You will be prompted
  289.      for a filename to save your keyboard definitions to) - I
  290.      recommend you select the default file 'Telix.Key' since this is
  291.      the keyboard file that is automatically loaded upon start-up of
  292.      TELIX v3.12.
  293.  
  294.      As an example, (using KEYS.SLC to display the assigned Function
  295.      keys,) here's a possible suggestion for key assignments to some
  296.      of the TELIX v3.12 Tools:
  297.  
  298.  ============================================================================
  299.  |                    Special Function Key Assignments                      |
  300.  |=======[F1-10]==========[AltF1-10]========[ShfF1-10]========[CtrF1-10]=====
  301.  | 1| @Keys           | @DialDir        |                 |                 |
  302.  |--|-----------------|-----------------|-----------------|-----------------|
  303.  | 2| @LoadKeys       | @PInstall       |                 |                 |
  304.  |--|-----------------|-----------------|-----------------|-----------------|
  305.  | 3| @Seditor        | @Searcher       |                 |                 |
  306.  |--|-----------------|-----------------|-----------------|-----------------|
  307.  | 4| @ListDir        |                 |                 |                 |
  308.  |--|-----------------|-----------------|-----------------|-----------------|
  309.  | 5| @ViewFile       |                 |                 |                 |
  310.  |--|-----------------|-----------------|-----------------|-----------------|
  311.  | 6| @RoboLog        |                 |                 |                 |
  312.  |--|-----------------|-----------------|-----------------|-----------------|
  313.  | 7| @AnsiScrn       |                 |                 |                 |
  314.  |--|-----------------|-----------------|-----------------|-----------------|
  315.  | 8| @DateTime       |                 |                 |                 |
  316.  |--|-----------------|-----------------|-----------------|-----------------|
  317.  | 9| @AsciiUp        |                 |                 |                 |
  318.  |--|-----------------|-----------------|-----------------|-----------------|
  319.  |10| @LogOff         |                 |                 |                 |
  320.  ========================[Press any key to continue]=========================
  321.  
  322. A Note on Script Files
  323. ----------------------
  324.    Just as "line-noise" reeks havoc with your terminal and connection,
  325.    scripts (that are of a "log-on nature") can also suffer. In the
  326.    event there is extreme line noise and the script is not functioning
  327.    as intended, you can abort at anytime. Simply press "Esc" and
  328.    answer "yes" to cancel the script completely. This will merely
  329.    leave you wherever you were when the script was operating.
  330.  
  331.    All included Scripts are "safe." Meaning, none of them, if a
  332.    problem does occur, will hinder or harm normal operations while
  333.    on-line. The worst case scenario would be a "hanging" of the script
  334.    due to either line-noise interference, or other unforeseen
  335.    circumstances. Any Script can be aborted, at any time, simply by
  336.    pressing "Esc" and choosing "cancel script" when prompted.
  337.  
  338.  
  339. Tips on usage, and TELIX v3.12 ".KEY" files
  340. --------------------------------------------
  341.    Chances are, you have many BBS's you log onto. Generally, I keep a
  342.    different ".KEY" file for different BBS's (sometimes, more than one
  343.    per BBS). This allows me to keep "special keys" for each BBS
  344.    separate.
  345.  
  346.                 Loading a script from the command line
  347.                 --------------------------------------
  348. Telix supports loading a script from the command, as you start-up
  349. Telix. Sometimes, if you keep separate key files for assorted tasks,
  350. you may want to load the script "Loadkeys" as you enter Telix. This
  351. way, immediately you will be able to choose the keyfile you want to
  352. start with (Telix does not support loading a key file from the command
  353. line).
  354. To do this (or to load ANY script as you start Telix) issue from the
  355. Dos command line:
  356.  
  357.                        Telix s[scriptfile name]
  358.        (leave the brackets off. There should be no spaces between the
  359.        's' and the scriptfile name. For example:
  360.  
  361.                            Telix sloadkeys
  362.  
  363.        Would start Telix, and automatically execute the script called
  364.  
  365.                              "loadkeys".
  366.  
  367. All Scripts were written and compiled using SALT, the TELIX v3.12
  368. script language provided as in integrated part of TELIX v3.12 itself.
  369. TELIX v3.12 has one of the most powerful scripting languages I have
  370. seen (aside from some of the more expensive packages, such as
  371. CROSSTALK Mach IV) and is very similar in nature to the 'C' language.
  372.  
  373.                 Comments are welcome, and appreciated.
  374.    If you have further questions or discover any problems, contact:
  375.                             Michael Gillum
  376.                                   at
  377.                              213-787-9461
  378.